Inside Macintosh: Programming With the Text Encoding Conversion Manager /

Chapter 4 - Unicode Converter Reference / Unicode Converter Functions

Converting From Unicode to Multiple Encodings /

CreateUnicodeToTextRunInfoByScriptCode

Based on the given script codes for the converted text runs, creates and returns a Unicode converter object containing information required for converting strings from Unicode to one or more specified non-Unicode encodings.

pascal OSStatus CreateUnicodeToTextRunInfoByScriptCode(
      ItemCount iNumberOfScriptCodes,
      const ScriptCode iScripts[],
      UnicodeToTextRunInfo *oUnicodeToTextInfo)

iNumberOfScriptCodes

The number of desired scripts. If you pass 0 for this parameter, the converter uses all the scripts installed in the system. In this case, the primary script is the one with highest priority; ScriptOrder ('itlm' resource) determines the priority of the rest. If you set the high-order bit for this parameter, the Unicode converter assumes that the iScripts parameter contains a single element specifying the preferred script. This feature is supported beginning with the Text Encoding Conversion Manager 1.2.

iScripts

An array of script codes for the desired scripts. Your application provides this structure to identify the scripts to be used for the conversion. The order in which you specify the scripts determines their priority. If you pass NULL for this parameter, the converter uses all of the scripts installed in the system. In this case, the primary script is the one with the highest priority and the priority order of the remaining scripts is defined by the ScriptOrder(itlm resource) resource. This feature is supported for versions 1.2 or later of the converter.

oUnicodeToTextInfo

A pointer to a Unicode converter object for converting Unicode text strings to strings in one or more non-Unicode encodings. On output, a Unicode converter object that holds the scripts you supply as the iScripts parameter and the state information related to the conversion.

function result

A result code. See "Text Encoding Conversion Manager Result Codes" (page 42) in the chapter "Basic Text Types Reference."

DISCUSSION

You pass a Unicode converter object returned from CreateUnicodeToTextRunInfoByScriptCode to the function ConvertFromUnicodeToTextRun (page 150) or ConvertFromUnicodeToScriptCodeRun (page 155) to identify the information to be used for the conversion. These two functions modify the contents of the Unicode converter object.